M

ParameterFilterElement.Create

Description:
Creates a new ParameterFilterElement in the given document.

Overloads (2):

Create

Create(Document,String,ICollection[ElementId])

Create(Document,String,ICollection[ElementId],ElementFilter)

public static ParameterFilterElement Create(
	Document aDocument,
	string name,
	ICollection<ElementId> categories,
	ElementFilter elementFilter
)

Public Shared Function Create ( 
	aDocument As Document,
	name As String,
	categories As ICollection(Of ElementId),
	elementFilter As ElementFilter
) As ParameterFilterElement

public:
static ParameterFilterElement^ Create(
	Document^ aDocument, 
	String^ name, 
	ICollection<ElementId^>^ categories, 
	ElementFilter^ elementFilter
)

static member Create : 
        aDocument : Document * 
        name : string * 
        categories : ICollection<ElementId> * 
        elementFilter : ElementFilter -> ParameterFilterElement

Document

aDocument

The document in which to create the ParameterFilterElement.
String

name

The user-visible name for the new ParameterFilterElement.
ICollection<ElementId>

categories

The categories for the new ParameterFilterElement.
ElementFilter

elementFilter
The rules for the new ParameterFilterElement, represented as an ElementFilter. ElementFilter is either an ElementParameterFilter or an ElementLogicalFilter representing a Boolean combination of ElementParameterFilters. In addition, we check that each ElementParameterFilter satisfies the following conditions: Its array of FilterRules is not empty and contains:
- Any number of FilterRules of type FilterValueRule, FilterInverseRule, and SharedParameterApplicableRule or
- Exactly one FilterCategoryRule containing only one category from categories stored by this ParameterFilterElement or
- Exactly two rules: the first one is a FilterCategoryRule containing only one category from categories stored by this ParameterFilterElement and the second one is a FilterRule of type FilterValueRule, FilterInverseRule, or SharedParameterApplicableRule.
Note that cases in the second and third bullet are currently allowed only if the parent node of ElementParameterFilter is LogicalOrFilter.

Return Value ParameterFilterElement A pointer to the new ParameterFilterElement.

ArgumentException

name is an empty string or contains only whitespace. -or- name cannot include prohibited characters, such as "{, }, [, ], |, ;, less-than sign, greater-than sign, ?, `, ~". -or- The given value for name is already in use as a filter element name. -or- One of the given rules refers to a parameter that does not apply to this filter's categories.
ArgumentNullException

A non-optional argument was null
ArgumentsInconsistentException

The ElementFilter is not acceptable for use by a ParameterFilterElement.